<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkTooltips</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
<link rel="up" href="DeprecatedObjects.html" title="Deprecated">
<link rel="prev" href="GtkText.html" title="GtkText">
<link rel="next" href="GtkTipsQuery.html" title="GtkTipsQuery">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkText.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="DeprecatedObjects.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ 2 Reference Manual</th>
<td><a accesskey="n" href="GtkTipsQuery.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkTooltips.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GtkTooltips.description" class="shortcut">Description</a>
                   | 
                  <a href="#GtkTooltips.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="GtkTooltips"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkTooltips.top_of_page"></a>GtkTooltips</span></h2>
<p>GtkTooltips — Add tips to your widgets</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkTooltips.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;gtk/gtk.h&gt;

struct              <a class="link" href="GtkTooltips.html#GtkTooltips-struct" title="struct GtkTooltips">GtkTooltips</a>;
struct              <a class="link" href="GtkTooltips.html#GtkTooltipsData" title="struct GtkTooltipsData">GtkTooltipsData</a>;
<a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="returnvalue">GtkTooltips</span></a> *       <a class="link" href="GtkTooltips.html#gtk-tooltips-new" title="gtk_tooltips_new ()">gtk_tooltips_new</a>                    (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GtkTooltips.html#gtk-tooltips-enable" title="gtk_tooltips_enable ()">gtk_tooltips_enable</a>                 (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GtkTooltips.html#gtk-tooltips-disable" title="gtk_tooltips_disable ()">gtk_tooltips_disable</a>                (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GtkTooltips.html#gtk-tooltips-set-delay" title="gtk_tooltips_set_delay ()">gtk_tooltips_set_delay</a>              (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> delay</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GtkTooltips.html#gtk-tooltips-set-tip" title="gtk_tooltips_set_tip ()">gtk_tooltips_set_tip</a>                (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tip_text</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tip_private</code></em>);
<a class="link" href="GtkTooltips.html#GtkTooltipsData" title="struct GtkTooltipsData"><span class="returnvalue">GtkTooltipsData</span></a> *   <a class="link" href="GtkTooltips.html#gtk-tooltips-data-get" title="gtk_tooltips_data_get ()">gtk_tooltips_data_get</a>               (<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GtkTooltips.html#gtk-tooltips-force-window" title="gtk_tooltips_force_window ()">gtk_tooltips_force_window</a>           (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GtkTooltips.html#gtk-tooltips-get-info-from-tip-window" title="gtk_tooltips_get_info_from_tip_window ()">gtk_tooltips_get_info_from_tip_window</a>
                                                        (<em class="parameter"><code><a class="link" href="GtkWindow.html" title="GtkWindow"><span class="type">GtkWindow</span></a> *tip_window</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> **tooltips</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> **current_widget</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GtkTooltips.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
               +----GtkTooltips
</pre>
</div>
<div class="refsect1">
<a name="GtkTooltips.description"></a><h2>Description</h2>
<p>
<a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> has been deprecated in GTK+ 2.12, in favor of the new
<a class="link" href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a> API.
</p>
<p>
Tooltips are the messages that appear next to a widget when the mouse pointer is held over it for a short amount of time. They are especially helpful for adding more verbose descriptions of things such as buttons in a toolbar.
</p>
<p>
An individual tooltip belongs to a group of tooltips. A group is created with a call to <a class="link" href="GtkTooltips.html#gtk-tooltips-new" title="gtk_tooltips_new ()"><code class="function">gtk_tooltips_new()</code></a>. Every tooltip in the group can then be turned off with a call to <a class="link" href="GtkTooltips.html#gtk-tooltips-disable" title="gtk_tooltips_disable ()"><code class="function">gtk_tooltips_disable()</code></a> and enabled with <a class="link" href="GtkTooltips.html#gtk-tooltips-enable" title="gtk_tooltips_enable ()"><code class="function">gtk_tooltips_enable()</code></a>.
</p>
<p>
The length of time the user must keep the mouse over a widget before the tip is shown, can be altered with <a class="link" href="GtkTooltips.html#gtk-tooltips-set-delay" title="gtk_tooltips_set_delay ()"><code class="function">gtk_tooltips_set_delay()</code></a>. This is set on a 'per group of tooltips' basis.
</p>
<p>
To assign a tip to a particular <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>, <a class="link" href="GtkTooltips.html#gtk-tooltips-set-tip" title="gtk_tooltips_set_tip ()"><code class="function">gtk_tooltips_set_tip()</code></a> is used.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
Tooltips can only be set on widgets which have their own X window and
receive enter and leave events.
To check if a widget has its own window use <a class="link" href="GtkWidget.html#GTK-WIDGET-NO-WINDOW:CAPS" title="GTK_WIDGET_NO_WINDOW()"><code class="function">GTK_WIDGET_NO_WINDOW()</code></a>.
To add a tooltip to a widget that doesn't have its own window, place the
widget inside a <a class="link" href="GtkEventBox.html" title="GtkEventBox"><span class="type">GtkEventBox</span></a> and add a tooltip to that instead.
</p>
</div>
<p>
The default appearance of all tooltips in a program is determined by the current GTK+ theme that the user has selected.
</p>
<p>
Information about the tooltip (if any) associated with an arbitrary widget can be retrieved using <a class="link" href="GtkTooltips.html#gtk-tooltips-data-get" title="gtk_tooltips_data_get ()"><code class="function">gtk_tooltips_data_get()</code></a>.
</p>
<p>
</p>
<div class="example">
<a name="id1293959"></a><p class="title"><b>Example 65. Adding tooltips to buttons.</b></p>
<div class="example-contents">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">load_button</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">save_button</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">hbox</span><span class="symbol">;</span>
<span class="usertype">GtkTooltips</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">button_bar_tips</span><span class="symbol">;</span>
<span class="normal">button_bar_tips </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkTooltips.html#gtk-tooltips-new">gtk_tooltips_new</a></span><span class="normal"> </span><span class="symbol">();</span>
<span class="comment">/* Create the buttons and pack them into a GtkHBox */</span>
<span class="normal">hbox </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkHBox.html#gtk-hbox-new">gtk_hbox_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">2</span><span class="symbol">);</span>
<span class="normal">load_button </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkButton.html#gtk-button-new-with-label">gtk_button_new_with_label</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Load a file"</span><span class="symbol">);</span>
<span class="function"><a href="GtkBox.html#gtk-box-pack-start">gtk_box_pack_start</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_BOX</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">hbox</span><span class="symbol">),</span><span class="normal"> load_button</span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">2</span><span class="symbol">);</span>
<span class="function"><a href="GtkWidget.html#gtk-widget-show">gtk_widget_show</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">load_button</span><span class="symbol">);</span>
<span class="normal">save_button </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkButton.html#gtk-button-new-with-label">gtk_button_new_with_label</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Save a file"</span><span class="symbol">);</span>
<span class="function"><a href="GtkBox.html#gtk-box-pack-start">gtk_box_pack_start</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_BOX</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">hbox</span><span class="symbol">),</span><span class="normal"> save_button</span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">2</span><span class="symbol">);</span>
<span class="function"><a href="GtkWidget.html#gtk-widget-show">gtk_widget_show</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">save_button</span><span class="symbol">);</span>
<span class="function"><a href="GtkWidget.html#gtk-widget-show">gtk_widget_show</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">hbox</span><span class="symbol">);</span>
<span class="comment">/* Add the tips */</span>
<span class="function"><a href="GtkTooltips.html#gtk-tooltips-set-tip">gtk_tooltips_set_tip</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_TOOLTIPS</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">button_bar_tips</span><span class="symbol">),</span><span class="normal"> load_button</span><span class="symbol">,</span>
<span class="normal">                 </span><span class="string">"Load a new document into this window"</span><span class="symbol">,</span>
<span class="normal">                 </span><span class="string">"Requests the filename of a document.</span>
<span class="string">                  This will then be loaded into the current</span>
<span class="string">                  window, replacing the contents of whatever</span>
<span class="string">                  is already loaded."</span><span class="symbol">);</span>
<span class="function"><a href="GtkTooltips.html#gtk-tooltips-set-tip">gtk_tooltips_set_tip</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_TOOLTIPS</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">button_bar_tips</span><span class="symbol">),</span><span class="normal"> save_button</span><span class="symbol">,</span>
<span class="normal">                 </span><span class="string">"Saves the current document to a file"</span><span class="symbol">,</span>
<span class="normal">                 </span><span class="string">"If you have saved the document previously,</span>
<span class="string">                  then the new version will be saved over the</span>
<span class="string">                  old one. Otherwise, you will be prompted for</span>
<span class="string">                  a filename."</span><span class="symbol">);</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

</div>
<p><br class="example-break">
</p>
</div>
<div class="refsect1">
<a name="GtkTooltips.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GtkTooltips-struct"></a><h3>struct GtkTooltips</h3>
<pre class="programlisting">struct GtkTooltips;</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">GtkTooltips</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>Holds information about a group of tooltips. Fields should be changed using the functions provided, rather than directly accessing the struct's members.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkTooltipsData"></a><h3>struct GtkTooltipsData</h3>
<pre class="programlisting">struct GtkTooltipsData {
  GtkTooltips *tooltips;
  GtkWidget *widget;
  gchar *tip_text;
  gchar *tip_private;
};
</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">GtkTooltipsData</code> has been deprecated since version 2.12 and should not be used in newly-written code. </p>
</div>
<p>
<em class="structfield"><code>tooltips</code></em> is the <a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> group that this tooltip belongs to. <em class="structfield"><code>widget</code></em> is the <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> that this tooltip data is associated with. <em class="structfield"><code>tip_text</code></em> is a string containing the tooltip message itself.</p>
<p>
<em class="structfield"><code>tip_private</code></em> is a string that is not shown as the default tooltip. Instead, this message may be more informative and go towards forming a context-sensitive help system for your application. (FIXME: how to actually "switch on" private tips?)
</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-tooltips-new"></a><h3>gtk_tooltips_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="returnvalue">GtkTooltips</span></a> *       gtk_tooltips_new                    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_tooltips_new</code> has been deprecated since version 2.12 and should not be used in newly-written code. </p>
</div>
<p>
Creates an empty group of tooltips. This function initialises a <a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> structure. Without at least one such structure, you can not add tips to your application.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> group for you to use.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-tooltips-enable"></a><h3>gtk_tooltips_enable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tooltips_enable                 (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_tooltips_enable</code> has been deprecated since version 2.12 and should not be used in newly-written code. </p>
</div>
<p>
Allows the user to see your tooltips as they navigate your application.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>tooltips</code></em> :</span></p></td>
<td>a <a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-tooltips-disable"></a><h3>gtk_tooltips_disable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tooltips_disable                (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_tooltips_disable</code> has been deprecated since version 2.12 and should not be used in newly-written code. </p>
</div>
<p>
Causes all tooltips in <em class="parameter"><code>tooltips</code></em> to become inactive. Any widgets that have tips associated with that group will no longer display their tips until they are enabled again with <a class="link" href="GtkTooltips.html#gtk-tooltips-enable" title="gtk_tooltips_enable ()"><code class="function">gtk_tooltips_enable()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>tooltips</code></em> :</span></p></td>
<td>a <a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-tooltips-set-delay"></a><h3>gtk_tooltips_set_delay ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tooltips_set_delay              (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> delay</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_tooltips_set_delay</code> has been deprecated since version 2.12 and should not be used in newly-written code. </p>
</div>
<p>
Sets the time between the user moving the mouse over a widget and the widget's tooltip appearing.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>tooltips</code></em> :</span></p></td>
<td>a <a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>delay</code></em> :</span></p></td>
<td>an integer value representing milliseconds.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-tooltips-set-tip"></a><h3>gtk_tooltips_set_tip ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tooltips_set_tip                (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tip_text</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tip_private</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_tooltips_set_tip</code> has been deprecated since version 2.12 and should not be used in newly-written code. </p>
</div>
<p>
Adds a tooltip containing the message <em class="parameter"><code>tip_text</code></em> to the specified <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>tooltips</code></em> :</span></p></td>
<td>a <a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
<td>the <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> you wish to associate the tip with.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tip_text</code></em> :</span></p></td>
<td>a string containing the tip itself. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tip_private</code></em> :</span></p></td>
<td>a string of any further information that may be useful if the user gets stuck. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-tooltips-data-get"></a><h3>gtk_tooltips_data_get ()</h3>
<pre class="programlisting"><a class="link" href="GtkTooltips.html#GtkTooltipsData" title="struct GtkTooltipsData"><span class="returnvalue">GtkTooltipsData</span></a> *   gtk_tooltips_data_get               (<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_tooltips_data_get</code> has been deprecated since version 2.12 and should not be used in newly-written code. </p>
</div>
<p>
Retrieves any <a class="link" href="GtkTooltips.html#GtkTooltipsData" title="struct GtkTooltipsData"><span class="type">GtkTooltipsData</span></a> previously associated with the given widget.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
<td>a <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="GtkTooltips.html#GtkTooltipsData" title="struct GtkTooltipsData"><span class="type">GtkTooltipsData</span></a> struct, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the widget has no tooltip.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-tooltips-force-window"></a><h3>gtk_tooltips_force_window ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tooltips_force_window           (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_tooltips_force_window</code> has been deprecated since version 2.12 and should not be used in newly-written code. </p>
</div>
<p>
Ensures that the window used for displaying the given <em class="parameter"><code>tooltips</code></em> is created.
</p>
<p>
Applications should never have to call this function, since GTK+ takes
care of this.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>tooltips</code></em> :</span></p></td>
<td>a <span class="type">GtkToolTips</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-tooltips-get-info-from-tip-window"></a><h3>gtk_tooltips_get_info_from_tip_window ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_tooltips_get_info_from_tip_window
                                                        (<em class="parameter"><code><a class="link" href="GtkWindow.html" title="GtkWindow"><span class="type">GtkWindow</span></a> *tip_window</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> **tooltips</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> **current_widget</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_tooltips_get_info_from_tip_window</code> has been deprecated since version 2.12 and should not be used in newly-written code. </p>
</div>
<p>
Determines the tooltips and the widget they belong to from the window in 
which they are displayed. 
</p>
<p>
This function is mostly intended for use by accessibility technologies;
applications should have little use for it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>tip_window</code></em> :</span></p></td>
<td>a <a class="link" href="GtkWindow.html" title="GtkWindow"><span class="type">GtkWindow</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tooltips</code></em> :</span></p></td>
<td>the return location for the tooltips which are displayed
in <em class="parameter"><code>tip_window</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>current_widget</code></em> :</span></p></td>
<td>the return location for the widget whose tooltips
are displayed, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>tip_window</code></em> is displaying tooltips, otherwise <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
</div>
<div class="refsect1">
<a name="GtkTooltips.see-also"></a><h2>See Also</h2>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="GtkToolbar.html" title="GtkToolbar"><span class="type">GtkToolbar</span></a></span></p></td>
<td><p>Create groups of widgets with their own tooltips.</p></td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="GtkTipsQuery.html" title="GtkTipsQuery"><span class="type">GtkTipsQuery</span></a></span></p></td>
<td><p>Query tooltips to create context-sensitive help.</p></td>
</tr>
</tbody>
</table></div>
<p>
</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>